docs(api): get openapi files from dependencies repository #1402
Conversation
| @@ -77,3 +77,34 @@ dependencies { | |||
| runtimeOnly(libs.edc.controlplane.callback.dispatcher.http) | |||
|
|
|||
| } | |||
|
|
|||
| tasks.register("downloadOpenapi") { | |||
There was a problem hiding this comment.
this should probably be in the root build file, because the dataplane also has an API and thus openAPI files
There was a problem hiding this comment.
I was thinking, do we need to list the dataplane api as well? Because those should be considered internal ones, same as "control" and "dsp", that's why I'm working to filter them out (update to PR will come up soon).
likely to external viewers only "management" and "observability" would be interesting, wdyt?
otherwise a possibility could be to publish them separately as we're doing on upstream
There was a problem hiding this comment.
well... I would not necessarily consider the dataplane signaling API external. And then there is the token-refresh API in Tractus-X, that is not part of the DPS, but I would still consider public. Thinking of third-party dataplanes, etc.
We can obviously do this in another iteration, but dataplane APIs should still be documented I think.
There was a problem hiding this comment.
not "external", but "internal".
token refresh is already part of the merged spec because it's not downloaded from maven repo but generated by the resolve task.
anyway I will add the task for both control-plane and data-plane, for management-api, observability-api and public-api, then let's wait for some feedback
There was a problem hiding this comment.
sorry, i meant to say that I would not consider them internal ofc.
token refresh is already part of the merged spec because it's not downloaded from maven repo but generated by the resolve task.
i know, my point was that the dataplane very much has APIs that are public, such as DPS and token refresh. especially with DPS i see no reason not to include it.
ndr-brt
force-pushed
the
1393-download-openapi-from-maven-repo
branch
from
f79b670 to
bff74f5
Compare
ndr-brt
force-pushed
the
1393-download-openapi-from-maven-repo
branch
2 times, most recently
from
b6f823e to
a14e347
Compare
ndr-brt
force-pushed
the
1393-download-openapi-from-maven-repo
branch
from
a14e347 to
14fc7d3
Compare
WHAT
Add a gradle task that downloads all the openapi specs of the dependencies and use them to build the merged spec to be uploaded to swaggerhub
WHY
documentation
FURTHER NOTES
Part of #1393